<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qbrush.cpp -->
  <title>QLinearGradient Class | Qt GUI 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QLinearGradient</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QLinearGradient Class</h1>
<!-- $$$QLinearGradient-brief -->
<p>The QLinearGradient class is used in combination with <a href="qbrush.html">QBrush</a> to specify a linear gradient brush. <a href="#details">More...</a></p>
<!-- @@@QLinearGradient -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QLinearGradient&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qgradient.html">QGradient</a></td></tr></table></div><ul>
<li><a href="qlineargradient-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#QLinearGradient-2">QLinearGradient</a></b>(qreal <i>x1</i>, qreal <i>y1</i>, qreal <i>x2</i>, qreal <i>y2</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#QLinearGradient-1">QLinearGradient</a></b>(const QPointF &amp;<i>start</i>, const QPointF &amp;<i>finalStop</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#QLinearGradient">QLinearGradient</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#finalStop">finalStop</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setFinalStop">setFinalStop</a></b>(const QPointF &amp;<i>stop</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setFinalStop-1">setFinalStop</a></b>(qreal <i>x</i>, qreal <i>y</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setStart">setStart</a></b>(const QPointF &amp;<i>start</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#setStart-1">setStart</a></b>(qreal <i>x</i>, qreal <i>y</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qlineargradient.html#start">start</a></b>() const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QLinearGradient-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Linear gradients interpolate colors between start and end points. Outside these points the gradient is either padded, reflected or repeated depending on the currently set <a href="qgradient.html#Spread-enum">spread</a> method:</p>
<div class="table"><table class="generic">
 <tr valign="top" class="odd"><td ><img src="images/qlineargradient-pad.png" alt="" /></td><td ><img src="images/qlineargradient-reflect.png" alt="" /></td><td ><img src="images/qlineargradient-repeat.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><a href="qgradient.html#Spread-enum">PadSpread</a> (default)</td><td ><a href="qgradient.html#Spread-enum">ReflectSpread</a></td><td ><a href="qgradient.html#Spread-enum">RepeatSpread</a></td></tr>
</table></div>
<p>The colors in a gradient is defined using stop points of the <a href="qgradient.html#QGradientStop-typedef">QGradientStop</a> type, i.e&#x2e; a position and a color. Use the <a href="qgradient.html#setColorAt">QGradient::setColorAt</a>() or the <a href="qgradient.html#setStops">QGradient::setStops</a>() function to define the stop points. It is the gradient's complete set of stop points that describes how the gradient area should be filled. If no stop points have been specified, a gradient of black at 0 to white at 1 is used.</p>
<p>In addition to the functions inherited from <a href="qgradient.html">QGradient</a>, the QLinearGradient class provides the <a href="qlineargradient.html#finalStop">finalStop</a>() function which returns the final stop point of the gradient, and the <a href="qlineargradient.html#start">start</a>() function returning the start point of the gradient.</p>
</div>
<p><b>See also </b><a href="qradialgradient.html">QRadialGradient</a>, <a href="qconicalgradient.html">QConicalGradient</a>, and <a href="../qtwidgets/qtwidgets-painting-gradients-example.html">The Gradients Example</a>.</p>
<!-- @@@QLinearGradient -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLinearGradient$$$QLinearGradientqrealqrealqrealqreal -->
<h3 class="fn" id="QLinearGradient-2"><a name="QLinearGradient-2"></a>QLinearGradient::<span class="name">QLinearGradient</span>(<span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>x1</i>, <span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>y1</i>, <span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>x2</i>, <span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>y2</i>)</h3>
<p>Constructs a linear gradient with interpolation area between (<i>x1</i>, <i>y1</i>) and (<i>x2</i>, <i>y2</i>).</p>
<p><b>Note: </b>The expected parameter values are in pixels.</p><p><b>See also </b><a href="qgradient.html#setColorAt">QGradient::setColorAt</a>() and <a href="qgradient.html#setStops">QGradient::setStops</a>().</p>
<!-- @@@QLinearGradient -->
<!-- $$$QLinearGradient$$$QLinearGradientconstQPointF&constQPointF& -->
<h3 class="fn" id="QLinearGradient-1"><a name="QLinearGradient-1"></a>QLinearGradient::<span class="name">QLinearGradient</span>(const <span class="type"><a href="../qtcore/qpointf.html">QPointF</a></span> &amp;<i>start</i>, const <span class="type"><a href="../qtcore/qpointf.html">QPointF</a></span> &amp;<i>finalStop</i>)</h3>
<p>Constructs a linear gradient with interpolation area between the given <i>start</i> point and <i>finalStop</i>.</p>
<p><b>Note: </b>The expected parameter values are in pixels.</p><p><b>See also </b><a href="qgradient.html#setColorAt">QGradient::setColorAt</a>() and <a href="qgradient.html#setStops">QGradient::setStops</a>().</p>
<!-- @@@QLinearGradient -->
<!-- $$$QLinearGradient[overload1]$$$QLinearGradient -->
<h3 class="fn" id="QLinearGradient"><a name="QLinearGradient"></a>QLinearGradient::<span class="name">QLinearGradient</span>()</h3>
<p>Constructs a default linear gradient with interpolation area between (0, 0) and (1, 1).</p>
<p><b>See also </b><a href="qgradient.html#setColorAt">QGradient::setColorAt</a>(), <a href="qlineargradient.html#setStart">setStart</a>(), and <a href="qlineargradient.html#setFinalStop">setFinalStop</a>().</p>
<!-- @@@QLinearGradient -->
<!-- $$$finalStop[overload1]$$$finalStop -->
<h3 class="fn" id="finalStop"><a name="finalStop"></a><span class="type"><a href="../qtcore/qpointf.html">QPointF</a></span> QLinearGradient::<span class="name">finalStop</span>() const</h3>
<p>Returns the final stop point of this linear gradient in logical coordinates.</p>
<p><b>See also </b><a href="qlineargradient.html#setFinalStop">setFinalStop</a>() and <a href="qgradient.html#stops">QGradient::stops</a>().</p>
<!-- @@@finalStop -->
<!-- $$$setFinalStop[overload1]$$$setFinalStopconstQPointF& -->
<h3 class="fn" id="setFinalStop"><a name="setFinalStop"></a><span class="type">void</span> QLinearGradient::<span class="name">setFinalStop</span>(const <span class="type"><a href="../qtcore/qpointf.html">QPointF</a></span> &amp;<i>stop</i>)</h3>
<p>Sets the final stop point of this linear gradient in logical coordinates to <i>stop</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#finalStop">finalStop</a>().</p>
<!-- @@@setFinalStop -->
<!-- $$$setFinalStop$$$setFinalStopqrealqreal -->
<h3 class="fn" id="setFinalStop-1"><a name="setFinalStop-1"></a><span class="type">void</span> QLinearGradient::<span class="name">setFinalStop</span>(<span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>x</i>, <span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>y</i>)</h3>
<p>This is an overloaded function.</p>
<p>Sets the final stop point of this linear gradient in logical coordinates to <i>x</i>, <i>y</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#start">start</a>().</p>
<!-- @@@setFinalStop -->
<!-- $$$setStart[overload1]$$$setStartconstQPointF& -->
<h3 class="fn" id="setStart"><a name="setStart"></a><span class="type">void</span> QLinearGradient::<span class="name">setStart</span>(const <span class="type"><a href="../qtcore/qpointf.html">QPointF</a></span> &amp;<i>start</i>)</h3>
<p>Sets the start point of this linear gradient in logical coordinates to <i>start</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#start">start</a>().</p>
<!-- @@@setStart -->
<!-- $$$setStart$$$setStartqrealqreal -->
<h3 class="fn" id="setStart-1"><a name="setStart-1"></a><span class="type">void</span> QLinearGradient::<span class="name">setStart</span>(<span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>x</i>, <span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> <i>y</i>)</h3>
<p>This is an overloaded function.</p>
<p>Sets the start point of this linear gradient in logical coordinates to <i>x</i>, <i>y</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qlineargradient.html#start">start</a>().</p>
<!-- @@@setStart -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn" id="start"><a name="start"></a><span class="type"><a href="../qtcore/qpointf.html">QPointF</a></span> QLinearGradient::<span class="name">start</span>() const</h3>
<p>Returns the start point of this linear gradient in logical coordinates.</p>
<p><b>See also </b><a href="qlineargradient.html#setStart">setStart</a>() and <a href="qgradient.html#stops">QGradient::stops</a>().</p>
<!-- @@@start -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
